Add comprehensive secrets and credentials management guide#112
Closed
dimitri-yatsenko wants to merge 2 commits into
Closed
Add comprehensive secrets and credentials management guide#112dimitri-yatsenko wants to merge 2 commits into
dimitri-yatsenko wants to merge 2 commits into
Conversation
- Fixed llms.txt manual reference from migrate-from-0x to migrate-to-v20 - Regenerated llms-full.txt to pick up all corrected migration guide links from PR #107 - Verified no remaining broken internal links in LLM documentation files
Addresses gap identified in cohesion review (COHESION-REVIEW.md Issue #3): - Missing authoritative guidance on .secrets/ structure - Configuration priority not clearly documented - No systematic coverage of credentials management across environments New guide (manage-secrets.md) provides: - Complete .secrets/ directory structure and usage - Configuration priority order (programmatic > env > secrets > config > defaults) - Database credentials (3 options: secrets dir, env vars, programmatic) - Object storage credentials (file-based and env-based) - Environment variable reference tables - Security best practices for dev, prod, CI/CD, Docker, cloud - Common patterns and troubleshooting - Configuration templates for different scenarios Also: - Added to how-to/index.md under Setup section - Regenerated llms-full.txt Impact: - New users have clear guidance on secure configuration - Covers all environments: local dev, production, CI/CD, containers, cloud - Complements configure-database.md and configure-storage.md with security focus Fixes: COHESION-REVIEW.md Issue #3 (High Priority)
This was referenced Jan 14, 2026
Member
Author
|
Consolidated into #119 - Documentation Cohesion Review: Comprehensive Improvements for DataJoint 2.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive guide for secure configuration management, addressing a critical gap identified in the cohesion review.
Problem
From cohesion review (COHESION-REVIEW.md Issue #3, High Priority):
.secrets/directory structure and usageSolution
New guide:
how-to/manage-secrets.md(500+ lines)Content Organization
Overview:
Database Credentials:
Object Storage Credentials:
Environment Variable Reference:
Security Best Practices:
Common Patterns:
Troubleshooting:
Configuration Templates:
Structure
Navigation Update
Added to
how-to/index.mdunder Setup section:User Impact
Before (Confusion)
After (Clarity)
Cross-References
The new guide complements existing docs:
configure-database.mdfor database-specific settingsconfigure-storage.mdfor storage-specific settingsRelated